7.2 Running reports

To run a report:

  1. Click the Reports category.

  2. From the drop-down list, select the report you want to run.

    See section 7.3, Available reports for information on each report, including details of what search criteria are available, what results are returned, the limit on the number of records returned.

  3. Complete the search criteria.

  4. Click SEARCH.

    The results are displayed. If the report allows it, you can click on a row to display the details of that item; for example, you can click on a record in the Unassigned Devices report to open the View Device screen for that device.

    Click the Download results button to download all results (up to the data limit, not restricted by what is currently on screen) to a CSV file in your browser's configured download folder:

    Access to the Download results feature is controlled by the Download Reports option in the Reports section of the Edit Roles workflow.

    There is a default limit of 20,000 results for downloaded reports. Systems that have been customized with Project Designer may have different limits.

    Note: You cannot download the results of an LDAP directory search.

7.2.1 Paging of results

Search results are displayed in pages. Scroll to retrieve the next page of results automatically. The number of displayed results is shown at the top of the form.

If more results are available, the text (scroll for more) appears; for example:

2008 results - 50 displayed (scroll for more) - 0 selected

2008 results - 2008 displayed - 0 selected

Note: LDAP searches have a default limit of 1000 items; for example:

250 displayed (scroll for more) - 0 selected

1000 displayed - 0 selected

7.2.2 Running reports through the MyID Core API

Instead of running reports through the MyID Operator Client, you can run the reports through the reports method of the MyID Core API.

To run the report through the API, you need the ID of the report, and the parameters used for the search criteria. These are listed along with the details of each report in this document.

For example, if you want to call the Available Device Stock report for a particular stock code and location, you need the ID of the report and the parameters used for stock code and location. In this case, the ID is 290009, and the parameters are stockCode and location.name.

For example:

https://myserver/rest.core/api/reports/290009?stockCode=Card&location.name=Headquarters

To run the report with no search parameters, use the q=* parameter; for example:

https://myserver/rest.core/api/reports/290009?q=*

Results are returned in JSON format, and are paged as they are when running reports within the MyID Operator Client. The JSON results provides a link you can use to obtain the next page of results, if necessary; for example:

Copy 
{
  "op":"nextPage",
  "cat":"page",
  "desc":"Next Page of Results",
  "verb":"GET",
  "href":"reports/290009?stockCode=Card&location.name=Headquarters&page=2"
},            

To obtain a count of the total number of records, use the count endpoint for the report; for example:

https://myserver/rest.core/api/reports/290009/count?q=*

This returns a count of the total number of records, and indicates whether this total has reached the report data limit (by default, 20,000 records). For example:

Copy 
{
  "recordCount":9520,
  "maxReached":false
}

See the MyID Core API guide for details of authenticating to the API and calling its methods.